|
In engineering, technical documentation refers to any type of documentation that describes handling, functionality and architecture of a technical product or a product under development or use.〔(What is "technical documentation"? ) at Transcom.de. Accessed February 25, 2013.〕〔(What is Technical Documentation? ) at Tetras Translations. Accessed February 25, 2013.〕〔(Documenting the New System ) at IGCSE ICT. Accessed February 25, 2013.〕 The intended recipient for product technical documentation is both the (proficient) end user as well as the administrator / service or maintenance technician. In contrast to a mere "cookbook" manual, technical documentation aims at providing enough information for a user to understand inner and outer dependencies of the product at hand. If technical writers are employed by the technology company, their task is to translate the usually highly formalized or abbreviated technical documentation produced during the development phase into more readable, "user-friendly" prose. The documentation accompanying a piece of technology is often the only means by which the user can fully understand said technology; regardless, technical documentation is often considered a "necessary evil" by software developers. Consequently, the genre has suffered from what some industry experts lament as a lack of attention and precision.〔(The Documentation Scene ) by John Mobbs. Institute of Scientific and Technical Communicators, Monday, July 23, 2012.〕 ==Forms of technical documentation== Technical documentation may include: * patents * specifications of item or of components/materials * data sheets of item or of components/materials * test methods * manufacturing standards * quality management system requirements * information specified in laws or regulations * verification and validation * Quad charts During development, a multitude of document types will play a significant role: *system requirements *system design *system architecture and various intermediate or intervening documents thereof. 抄文引用元・出典: フリー百科事典『 ウィキペディア（Wikipedia）』 ■ウィキペディアで「Technical documentation」の詳細全文を読む スポンサード リンク
|